ServerData
The data source server object and its settings.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
|
The data source's system ID |
- |
string |
|
|
The data source server's caption or name |
Y |
string |
|
|
The data source server type enumeration. |
Y |
||
|
The data source server's IP address or FQDN |
Y |
string |
|
|
The instance name of the data source (if relevant) |
- |
string |
|
|
The data source server's port number |
- |
integer |
int32 |
|
Read=0, Write=1, Default:Read |
- |
integer |
int32 |
|
Optional parameters for data source connection |
- |
string |
|
|
Boolean flag if the data source will be secured by each end-user |
- |
boolean |
|
|
The data source security type enumeration. |
- | ||
|
User Id needed for connection |
- |
string |
|
|
User password need for connection |
- |
string |
|
|
The tenant ID that the data source will be attached to |
- |
string |
|
|
Additional data source connection properties and settings used OPTIONALLY for different server types. |
- | ||
|
Boolean to flag if the global account should be sued for connecting. Default:false |
- |
boolean |
|
|
The Pulse client ID if used with the data source |
- |
string |
|
|
The default database to be used with the data source |
- |
string |
|
|
Boolean flag if the data source will use Pyramid's security and metadta overlays |
- |
boolean |
|
|
- |
string |
*Required elements are only used for API parameters
Usages






